Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add LOTS of missing docs #36773

Merged
merged 1 commit into from
Mar 13, 2020
Merged

Add LOTS of missing docs #36773

merged 1 commit into from
Mar 13, 2020

Conversation

KoBeWi
Copy link
Member

@KoBeWi KoBeWi commented Mar 3, 2020

Brings the completion from 88% to 91%

Expect many mistakes, because I didn't double-check like usual.

@KoBeWi KoBeWi requested a review from a team as a code owner March 3, 2020 18:25
dalexeev
dalexeev reviewed Mar 4, 2020
View reviewed changes
doc/classes/Sprite.xml Outdated Show resolved Hide resolved
@akien-mga akien-mga added this to the 4.0 milestone Mar 4, 2020
@akien-mga akien-mga added the cherrypick:3.x Considered for cherry-picking into a future 3.x release label Mar 4, 2020
akien-mga
akien-mga reviewed Mar 4, 2020
View reviewed changes
Copy link
Member

@akien-mga akien-mga left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Partial review, only files starting with A, B and C :)

doc/classes/Animation.xml Outdated Show resolved Hide resolved
doc/classes/Animation.xml Outdated Show resolved Hide resolved
doc/classes/Animation.xml Outdated Show resolved Hide resolved
doc/classes/Animation.xml Outdated Show resolved Hide resolved
doc/classes/Animation.xml Outdated Show resolved Hide resolved
doc/classes/AudioEffectRecord.xml Outdated Show resolved Hide resolved
doc/classes/AudioEffectRecord.xml Outdated Show resolved Hide resolved
doc/classes/BaseMaterial3D.xml Outdated Show resolved Hide resolved
doc/classes/BaseMaterial3D.xml Outdated Show resolved Hide resolved
doc/classes/BaseMaterial3D.xml Outdated Show resolved Hide resolved
@KoBeWi
Copy link
Member Author

KoBeWi commented Mar 4, 2020

When doing this PR, I tried to fill in the brief descriptions if they were easy, but descriptions usually need more details and I wasn't sure what to add there. It should be fine to leave them probably, it's not like this PR has to fill everything xd (and incomplete is better than empty anyways IMO)

As for AnimationNode classes, I copied most of their descriptions from the tutorial, so the errors that were corrected here likely still exist in the tutorial.

@KoBeWi KoBeWi force-pushed the thats_a_lotta_docs branch 2 times, most recently from b887094 to 37fa00a Compare March 4, 2020 23:08
clayjohn
clayjohn reviewed Mar 5, 2020
View reviewed changes
Copy link
Member

@clayjohn clayjohn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I didn't add suggestions for all the *FILTER* enums because I can only comment on lines that you edited. Don't worry about them though. They can get filled in later.

doc/classes/BaseMaterial3D.xml Show resolved Hide resolved
doc/classes/BaseMaterial3D.xml Outdated Show resolved Hide resolved
doc/classes/CanvasItem.xml Outdated Show resolved Hide resolved
doc/classes/Texture2DArray.xml Outdated Show resolved Hide resolved
akien-mga
akien-mga reviewed Mar 5, 2020
View reviewed changes
doc/classes/Callable.xml Outdated Show resolved Hide resolved
akien-mga
akien-mga reviewed Mar 5, 2020
View reviewed changes
Copy link
Member

@akien-mga akien-mga left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed until letter R, included.

doc/classes/Callable.xml Outdated Show resolved Hide resolved
doc/classes/Callable.xml Outdated Show resolved Hide resolved
doc/classes/Callable.xml Outdated Show resolved Hide resolved
doc/classes/Callable.xml Outdated Show resolved Hide resolved
doc/classes/CollisionPolygon2D.xml Outdated Show resolved Hide resolved
doc/classes/ResourceLoader.xml
@@ -96,6 +98,7 @@
<argument index="2" name="use_sub_threads" type="bool" default="false">
</argument>
<description>
Loads the resource using threads. If [code]use_sub_threads[/code] is [code]true[/code], multiple threads will be used to load the resource, which makes loading faster, but may affect the main thread (and thus cause game slowdowns).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A usage example would be good, but that can be done in another PR/by someone else.

doc/classes/RichTextLabel.xml Outdated Show resolved Hide resolved
doc/classes/RichTextLabel.xml Outdated Show resolved Hide resolved
doc/classes/RichTextLabel.xml Outdated Show resolved Hide resolved
doc/classes/RichTextLabel.xml Show resolved Hide resolved
@KoBeWi KoBeWi force-pushed the thats_a_lotta_docs branch 3 times, most recently from b2d984e to d5d22c3 Compare March 5, 2020 12:48
@KoBeWi KoBeWi mentioned this pull request Mar 5, 2020
Open
akien-mga
akien-mga reviewed Mar 13, 2020
View reviewed changes
Copy link
Member

@akien-mga akien-mga left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Last bunch of comments, I'm done with the proofreading.
It took a while, so I can't even imagine how long it took to write all those strings. Awesome work!

doc/classes/Signal.xml Outdated Show resolved Hide resolved
doc/classes/Signal.xml Outdated Show resolved Hide resolved
doc/classes/Signal.xml Outdated Show resolved Hide resolved
doc/classes/Signal.xml Outdated Show resolved Hide resolved
doc/classes/StringName.xml Outdated Show resolved Hide resolved
doc/classes/VSplitContainer.xml Outdated Show resolved Hide resolved
doc/classes/VisualShader.xml Outdated Show resolved Hide resolved
doc/classes/VisualShader.xml Outdated Show resolved Hide resolved
doc/classes/WindowDialog.xml Outdated Show resolved Hide resolved
doc/classes/WindowDialog.xml Outdated Show resolved Hide resolved
@KoBeWi KoBeWi force-pushed the thats_a_lotta_docs branch 2 times, most recently from b2c4fb6 to 2a2e769 Compare March 13, 2020 14:52
@KoBeWi
Copy link
Member Author

KoBeWi commented Mar 13, 2020

Ok, I fixed it all. The increment/decrement in TabContainer/Tabs might need another check, because the description was incorrect (sorry). Looks like lots of docs brings lots of mistakes :I

It took a while, so I can't even imagine how long it took to write all those strings.

Heh.

akien-mga
akien-mga reviewed Mar 13, 2020
View reviewed changes
doc/classes/TabContainer.xml Outdated Show resolved Hide resolved
doc/classes/TabContainer.xml Outdated Show resolved Hide resolved
@akien-mga akien-mga merged commit 0ed8d05 into godotengine:master Mar 13, 2020
@akien-mga
Copy link
Member

Thanks a ton! :)

@KoBeWi KoBeWi deleted the thats_a_lotta_docs branch March 13, 2020 16:04
@akien-mga
Copy link
Member

Cherry-picking for 3.2.2 via #37026.

@akien-mga akien-mga removed the cherrypick:3.x Considered for cherry-picking into a future 3.x release label Mar 13, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dalexeev dalexeev dalexeev left review comments

@clayjohn clayjohn clayjohn left review comments

@akien-mga akien-mga akien-mga left review comments

@aaronfranke aaronfranke aaronfranke left review comments

Assignees
No one assigned
Labels
documentation enhancement
Projects
None yet
Milestone
4.0
Development

Successfully merging this pull request may close these issues.
5 participants
@KoBeWi @akien-mga @aaronfranke @clayjohn @dalexeev